<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilsfl: xilsfl_ospi_flash_readwrite_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilsfl
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xilsfl__ospi__flash__readwrite__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xilsfl_ospi_flash_readwrite_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the SFL library The hardware which this example runs on, must have an octal serial nor flash for it to run. </p>
<p>This example has been tested with the Micron Octal Serial Flash(MT35XU02GCBA).</p>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>None.</p>
<p>MODIFICATION HISTORY:</p>
<p>Ver Who Date Changes </p>
<hr/>
<p> 1.0 sb 8/20/24 Initial release 1.0 sb 9/25/24 Use XSfl_FlashRead to read unaligned bytes. 1.1 sb 01/28/25 Add support for Lassen platform. 1.1 sb 02/11/25 Add condition to avoid dma read on Spartanup.</p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac9643c6f7d05d31e806a1697819800c2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xilsfl__ospi__flash__readwrite__example_8c.html#ac9643c6f7d05d31e806a1697819800c2">SflReadWriteExample</a> (void)</td></tr>
<tr class="memdesc:ac9643c6f7d05d31e806a1697819800c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">The purpose of this function is to illustrate how to use the SFL Library with SPI/QSPI/OSPI interfaced with flash devices.  <a href="#ac9643c6f7d05d31e806a1697819800c2">More...</a><br/></td></tr>
<tr class="separator:ac9643c6f7d05d31e806a1697819800c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xilsfl__ospi__flash__readwrite__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the SflReadWriteExample.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the SflReadWriteExample. </p>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, otherwise XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>References <a class="el" href="xilsfl__ospi__flash__readwrite__example_8c.html#ac9643c6f7d05d31e806a1697819800c2">SflReadWriteExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ac9643c6f7d05d31e806a1697819800c2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int SflReadWriteExample </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The purpose of this function is to illustrate how to use the SFL Library with SPI/QSPI/OSPI interfaced with flash devices. </p>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful, else XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="group__xilsfl.html#gaf127a84afb0c66b1acfe91a00fed4410">XSFL_BROKEN_DMA</a>, <a class="el" href="group__xilsfl.html#ga49eeaf1569748d56e0fa1742a50ee291">XSfl_FlashErase()</a>, <a class="el" href="group__xilsfl.html#ga2dc535e80a4fa46f52380b8ece695826">XSfl_FlashGetInfo()</a>, <a class="el" href="group__xilsfl.html#ga91e56d8af1dd4e5d1b5d614be6b123ec">XSfl_FlashInit()</a>, <a class="el" href="group__xilsfl.html#gacef7db1daf91e89b3e862517d5a2a8f0">XSfl_FlashRead()</a>, <a class="el" href="group__xilsfl.html#ga9b21dced60d227505db47cf933e44c59">XSfl_FlashReadDone()</a>, <a class="el" href="group__xilsfl.html#gab25ea5272a45a906d47d00423a6a7fdb">XSfl_FlashReadStart()</a>, <a class="el" href="group__xilsfl.html#ga826c63730a917b8de42d41d634a1b30f">XSfl_FlashWrite()</a>, <a class="el" href="group__xilsfl.html#gaeed79c966ab6be378b99780d590b7529">XSFL_OSPI_CNTRL</a>, and <a class="el" href="group__xilsfl.html#gabcd3734ba03a8f4d7088acb931bd46cd">XSFL_SELECT_FLASH_CS0</a>.</p>

<p>Referenced by <a class="el" href="xilsfl__ospi__flash__readwrite__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
